docs: clarify baggage current context behavior - #5397
Closed
goutamadwant wants to merge 1 commit into
Closed
Conversation
| finally: | ||
| context.detach(token) | ||
|
|
||
| This is the same model used by :mod:`opentelemetry.baggage`. |
Contributor
There was a problem hiding this comment.
Actually it's the other way around: baggage follows what is expected to do by the Context API.
Contributor
There was a problem hiding this comment.
i.e. no need to mention Baggage here.
|
This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment. |
|
This PR has been closed due to inactivity. Please reopen if you would like to continue working on it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Clarifies that baggage helpers return updated
Contextvalues and do not attach those values as the current context automatically.The docs now show the difference between reading baggage from an explicit context and reading baggage from the current context. They also include the
context.attach/context.detachpattern needed when callers want a returned context to become current.Fixes #2432
Type of change
How Has This Been Tested?
uv run tox -e docsDoes This PR Require a Contrib Repo Change?
Checklist: